Management API

Base Resource URL:

     https://sandbox-portal.zift.io/api/v01/[customers]

Description:

Provides access to customers registered within the system.

Available sub-resources:

Resource URL Description
https://sandbox-portal.zift.io/api/v01/[customers]/[customer-id]    Provides access to configuration settings for the specified customer.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  Customer *      
Consumes:  json, xml  Produces:  json, xml 
 
Creates a customer.

Parameters:
# Name Type Required Default Description
01 object Customer * Yes Represents information about the customer.

find  
Method:  GET       Implicit:  Yes       Returns:  Customer[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns a list of available customers based on specified search criteria.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 100 Maximum number of records to load per single search web call made by the customer.
03 accountId Integer No Account ID used for filtering records.
04 firstName String(125) No First name of the customer used for filtering Customer records.
05 lastName String(125) No Last name of the customer used for filtering Customer records.
06 organizationName String(255) No Name of the organization used for filtering Customer records.
07 email String(100) No Email address of the customer used for filtering Customer records.
08 phone String(15) No Phone number of the customer used for filtering Customer records.
09 street String(128) No Street of the mailing address of the customer used for filtering Customer records.
10 city String(50) No City of the mailing address of the customer used for filtering Customer records.
11 state String(3) No State code of the mailing address of the customer used for filtering Customer records.
12 zipCode String(10) No ZIP or postal code of the mailing address of the customer used for filtering Customer records.
13 countryCode String(2) No Country code of the mailing address of the customer used for filtering Customer records.

Copyright © Constellation Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.